'''
===DOC FILE===

\\\DOCUMENTATION-SETUP
A couple of doc-strings are used to serve as either documentation (ADAPHIS),
either future-changes (ADAPFUT) or work in progress (ADAPNOW). Together with
the FindFiles utility the relevant documentation can be found. This approach
therefore uses strongly in-code documentation.

Beware that the doc-strings in this documentation-module
ADAP and HIS are written together whereas in the code-modules they should be
written with a space between them. (also for FUT and NOW). This is to avoid
that this doc shows up in the FindFiles-result.

The design of a program-part (like function, class or module)
is firstly written in ADAPFUT(= adaptions future).
When no more items are listed under ADAPFUT,
please remove that header sothat it doesn't show up in Findfiles.
Then it is programmed and during that process the item is moved to ADAPNOW
When the programming is ready the item is moved to ADAPHIS. Also the header
ADAPNOW should be removed if it is without additional items.
ADAPHIS therefore describes the initial working of the unit, aswell as
the later changes applied to it. The first item holds the initial design,
but sometimes an extra 'unit info'-header can hold additional information.

FUT and NOW can temporarily be changed to FU and NO when there items have
been completed and moved.

The Findinfiles-window give an overview of all adapations.

Version-encoding is done by postfixing the version after the change-
request, like: 'create perspectives vrs_11.10'
Prioritizing items is done by postfixing an ordinal task-number after
the version like: vrs_11.10_t1

\\\CODING-CONVENTIONS
-variables:
    -use small letters
    -are aft-fixed with two letters that designate the datatype; the
    following are used:
        -st; string; filest
        -it; integer; numberit
        -fl; floating point-number / decimal
        -li; list; rangeli
        -di; dict; definitiondi
        -tu; tuple; rangetu
        -bo; boolean; testbo

-classes and functions
    -use camelCase notation with first letter small
        -the first small letters is important to avoid having to type
        a capital ever time if you work with code-completion.
    - use a verb first and then the grammatical object
    - examples: writeData(), updateListFields()
-always:
    - use descriptive names. It's easy for you to write short, undescriptive,
     names, but not for the reader of improver of your code!


\\\GLOBAL TASK-TREE
- do something with the 'tedo' items from the to-do list
- redesign code-separation and modularization
- check if the best start-up-code is implemented in all modules


\\\ VERSIONS - PAST AND FUTURE
done: version 1.0
main goal: make it usable for my self

done: version 1.2 - tree-queries
main goal: match functionality of access-code except generic list plus filter

done: version 1.3 - textual export and/or import to mobile device

version 1.4 - create an options-screen and move all hard-coded
constants to it

version 1.5 - gui-adaptations
-thruport-screen
-menu-update
-about screen

version 2.0
-new database, sqlite, works with pysqlite
-basic DB-management
-create executables and / or setup
    -add the (zipped) code with the setup
    -create versional and time-linked stamp
-add basic documentation


version 2.01
-small gui-changes to improve the appearance

-------------------now------------------------

version 2.x
-finish the query-window
-import and export of csv-text-files


version 3.0
-port from windows to linux
    -isolate platform-specificities in a separate-module


version 4.0
Enable plug-ins:
-diskbase en file-search-tool
-advanced file-launcher
-bookmark-database
-webcrawler voor weblinks
etc.


\\\USED PROGRAMS AND COMPONENTS
-py-scripter


\\\SUPPORTING HELP-DOCUMENTS    adap no
-Dive into python
-wxWidgets reference (html help file)
-wxPython demo (program)
-Cross-Platform GUI Programming with wxWidgets.pdf
-internet
    -google and google code search
    -www.python.org


\\\CODE-SEPARATION AND MODULARIZATION
??????? some irrational thoughts??
informational objects:
-db-types: msaccess, mysql, firebird
-datatypes;
-gui-types: wxwidgets, tkinter, html
-app-level: dbapp, guiapp, logic-app

dbt's can be all be generalized to certain generic datatypes. > logical db

Modules:
-dbt-generic
-db-generalization (common datatypes)
-app-logic (autonomous data-structures and -logic between db and gui)
-gui

xxx blabla

'''


